Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update the ZMK firmware descritpion #33

Merged
merged 4 commits into from
Sep 15, 2024
Merged

update the ZMK firmware descritpion #33

merged 4 commits into from
Sep 15, 2024

Conversation

280Zo
Copy link
Contributor

@280Zo 280Zo commented Sep 10, 2024

The scope of this PR is to update some of the wording about how to use the firmware. It also includes a short description about the firmware.
I've updated the firmware repo that's linked in this doc and it now builds both qwerty and colemak on the main branch. So it might be a good idea to update the wording to keep from confusing users who click on the link looking for different branches.
Cheers!

Copy link
Collaborator

@burkfers burkfers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your submission!

Please also add "nanov" to .wordlist.txt as a workaround to our spellchecker also picking up URLs. I cannot add this as a suggestion as github doesn't allow change suggestions on unchanged files.

nb: Spelling only; I cannot comment on the contents.

help/bluetooth.md Outdated Show resolved Hide resolved
help/bluetooth.md Outdated Show resolved Hide resolved
@280Zo
Copy link
Contributor Author

280Zo commented Sep 11, 2024

Thanks for catching those spelling mistakes! I've accepted the commits, and added "nanov" to the .wordlist.txt.
Let me know if there's anything else.

@burkfers burkfers requested a review from bstiq September 11, 2024 06:16
@bstiq
Copy link
Member

bstiq commented Sep 11, 2024

For some reason my other comment doesn't appear.

What's the reason you deleted those, is it not up to date anymore?


Note that the official ZMK firmware doesn't support the PMW3610 or mouse movement keys, both of which are used in the firmware above. To get a working firmware I leveraged the work of inorichi to get the PMW3610 driver, and the work of petejohanson for the driver to allow pointer movement and scrolling with keys.

Official ZMK support for mouse keys is being worked on, and when it's merged I'll switch back to the official ZMK firmware for the builds.

@280Zo
Copy link
Contributor Author

280Zo commented Sep 12, 2024

Great question. I should have put that in my initial message.
I'm playing around with other drivers (e.g. the dongle and PMW3610 driver from badjeff), and since it's possible the authors/repos would change, I took that section out.
If you think it's better left in until I merge the changes with main, I'm happy to add it back and then submit another PR if/when the drivers change.

@burkfers
Copy link
Collaborator

It seems to me you still mention inorichi's driver and Pete's mouse emulation branch, just moved further up (L. 184f). Only the link the the mouse emulation PR is removed.

Imho the link to the driver used should stay, both to tell the reader where to go for more information, and to give credit to the authors.
Another PR would be greatly appreciated once you do change to another driver.

Alternatively, you could add these descriptions to a readme in your repo and link it here; That way you have the freedom to change the documentation as you change the code. It's not directly relevant to the setup on the user's side, so not having it directly on the help page is fine.

@280Zo
Copy link
Contributor Author

280Zo commented Sep 13, 2024

Thanks for the feedback!
I've had the attribution and links in my readme since I started using them. Screenshot for reference:


image


Having the info there instead of the setup guide makes sense to me, but I'll leave the final decision up to you. If you prefer it in both locations, let me know and I'll gladly add another commit to restore the text.

@burkfers burkfers requested review from bstiq and removed request for bstiq September 13, 2024 20:31
@bstiq bstiq merged commit 22ff98a into Bastardkb:master Sep 15, 2024
1 check passed
@bstiq
Copy link
Member

bstiq commented Sep 15, 2024

Thanks for your contribution! 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants